Swagger\Client\MinerApi

All URIs are relative to //api.estuary.tech/

Method	HTTP request	Description
minerClaimMinerGet	GET /miner/claim/{miner}	Get Claim Miner Message
minerClaimPost	POST /miner/claim	Claim Miner
minerSetInfoMinerPut	PUT /miner/set-info/{miner}	Set Miner Info
minerSuspendMinerPost	POST /miner/suspend/{miner}	Suspend Miner
minerUnsuspendMinerPut	PUT /miner/unsuspend/{miner}	Unuspend Miner
publicMinersDealsMinerGet	GET /public/miners/deals/{miner}	Get all miners deals
publicMinersStatsMinerGet	GET /public/miners/stats/{miner}	Get miner stats

minerClaimMinerGet

\Swagger\Client\Model\ApiClaimMsgResponse minerClaimMinerGet($miner)

Get Claim Miner Message

This endpoint lets a user get the message in order to claim a miner

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\MinerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$miner = "miner_example"; // string | Miner claim message

try {
    $result = $apiInstance->minerClaimMinerGet($miner);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MinerApi->minerClaimMinerGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
miner	string	Miner claim message

Return type

\Swagger\Client\Model\ApiClaimMsgResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

minerClaimPost

\Swagger\Client\Model\ApiClaimResponse minerClaimPost($body)

Claim Miner

This endpoint lets a user claim a miner

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\MinerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Swagger\Client\Model\MinerClaimMinerBody(); // \Swagger\Client\Model\MinerClaimMinerBody | Claim Miner Body

try {
    $result = $apiInstance->minerClaimPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MinerApi->minerClaimPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\MinerClaimMinerBody	Claim Miner Body

Return type

\Swagger\Client\Model\ApiClaimResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: /
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

minerSetInfoMinerPut

\Swagger\Client\Model\ApiEmptyResp minerSetInfoMinerPut($body, $miner)

Set Miner Info

This endpoint lets a user set miner info.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\MinerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Swagger\Client\Model\MinerMinerSetInfoParams(); // \Swagger\Client\Model\MinerMinerSetInfoParams | Miner set info params
$miner = "miner_example"; // string | Miner to set info for

try {
    $result = $apiInstance->minerSetInfoMinerPut($body, $miner);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MinerApi->minerSetInfoMinerPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\MinerMinerSetInfoParams	Miner set info params
miner	string	Miner to set info for

Return type

\Swagger\Client\Model\ApiEmptyResp

Authorization

bearerAuth

HTTP request headers

• Content-Type: /
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

minerSuspendMinerPost

\Swagger\Client\Model\ApiEmptyResp minerSuspendMinerPost($body, $miner)

Suspend Miner

This endpoint lets a user suspend a miner.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\MinerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Swagger\Client\Model\MinerSuspendMinerBody(); // \Swagger\Client\Model\MinerSuspendMinerBody | Suspend Miner Body
$miner = "miner_example"; // string | Miner to suspend

try {
    $result = $apiInstance->minerSuspendMinerPost($body, $miner);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MinerApi->minerSuspendMinerPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\MinerSuspendMinerBody	Suspend Miner Body
miner	string	Miner to suspend

Return type

\Swagger\Client\Model\ApiEmptyResp

Authorization

bearerAuth

HTTP request headers

• Content-Type: /
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

minerUnsuspendMinerPut

\Swagger\Client\Model\ApiEmptyResp minerUnsuspendMinerPut($miner)

Unuspend Miner

This endpoint lets a user unsuspend a miner.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\MinerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$miner = "miner_example"; // string | Miner to unsuspend

try {
    $result = $apiInstance->minerUnsuspendMinerPut($miner);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MinerApi->minerUnsuspendMinerPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
miner	string	Miner to unsuspend

Return type

\Swagger\Client\Model\ApiEmptyResp

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

publicMinersDealsMinerGet

string publicMinersDealsMinerGet($miner, $ignore_failed)

Get all miners deals

This endpoint returns all miners deals

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\MinerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$miner = "miner_example"; // string | Filter by miner
$ignore_failed = "ignore_failed_example"; // string | Ignore Failed

try {
    $result = $apiInstance->publicMinersDealsMinerGet($miner, $ignore_failed);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MinerApi->publicMinersDealsMinerGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
miner	string	Filter by miner
ignore_failed	string	Ignore Failed	[optional]

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

publicMinersStatsMinerGet

string publicMinersStatsMinerGet($miner)

Get miner stats

This endpoint returns miner stats

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\MinerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$miner = "miner_example"; // string | Filter by miner

try {
    $result = $apiInstance->publicMinersStatsMinerGet($miner);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MinerApi->publicMinersStatsMinerGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
miner	string	Filter by miner

Return type

string

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]